/*
 * DBeaver - Universal Database Manager
 * Copyright (C) 2010-2023 DBeaver Corp and others
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jkiss.dbeaver.model.text.parser;

import org.eclipse.jface.text.IDocument;

/**
 * Token scanner
 */
public interface TPTokenScanner {

	/**
	 * Configures the scanner by providing access to the document range that should
	 * be scanned.
	 */
	void setRange(IDocument document, int offset, int length);

	/**
	 * Returns the next token in the document.
	 *
	 * @return the next token in the document
	 */
	TPToken nextToken();

	/**
	 * Returns the offset of the last token read by this scanner.
	 *
	 * @return the offset of the last token read by this scanner
	 */
	int getTokenOffset();

	/**
	 * Returns the length of the last token read by this scanner.
	 *
	 * @return the length of the last token read by this scanner
	 */
	int getTokenLength();
}
